MM-67108: Auto-generate Encryption Key on upgrade if missing #218
Conversation
When upgrading to v1.7.0+, users would see an error if the Encryption Key was not set. This change auto-generates a valid 32-character key if it's missing or invalid, and saves it to the plugin config. - Added generateRandomKey() helper function - Added savePluginConfig() to persist auto-generated keys - Existing valid keys are not overwritten - Plugin now starts successfully on upgrade without manual intervention
nevyangelova
added
2: Dev Review
jwilander
left a comment
jwilander
left a comment
There was a problem hiding this comment.
Looks good. I would like to see us starting to add unit tests to integrations but I won't block the PR on it as there's hardly any unit tests in the plugin at all.
- Test generateRandomKey() generates correct length and unique keys - Test OnConfigurationChange auto-generates key when missing - Test existing valid keys are not overwritten
|
@jwilander Opus helped generate the test quite quickly! Ran them and they look good, and I can't think of a missing case, let me know if you want to see another example? |
|
Great! The only other case I can think of is a negative integer being passed to |
|
@jwilander thanks for the suggestion! I considered adding validation for negative integers but generateRandomKey is a private function only called internally with a hardcoded value of 32 i don't see a code path where a negative or zero value could be passed. |
ogi-m
left a comment
ogi-m
left a comment
There was a problem hiding this comment.
LGTM! Verified the key gets auto-generated on upgrade
ogi-m
added
4: Reviews Complete
4 participants
Summary
When upgrading to v1.7.0 users would see an error if the Encryption Key was not set. This change auto generates a valid 32-character key if it's missing or invalid and saves it to the plugin config.
QA steps
Expected: Plugin activates successfully without errors
Check System Console → Plugins → Confluence - Encryption Key should now be auto-populated
Ticket Link
https://mattermost.atlassian.net/browse/MM-67108